readme: Update documentation of assertion macros #237
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
niwis
requested changes
Oct 4, 2024
|
Thanks @niwis for the super fast review. I committed your suggestions. Also, I updated the sentence highlighting the relationship with lowrisc's assertion macros, which made me realize that #233 has broken the previous compatibility with their macros. Please let me know if you consider this to be an issue that needs to be mitigated in some form. |
|
Hmm good point. Maybe we need to refine the include guards or rename the macros in the next major release. Can you open an issue for future reference? |
niwis
approved these changes
Oct 4, 2024
michael-platzer
deleted the
michael-platzer/readme/update-assert-macros
branch
Sure, will do. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
During my recent changes to the assertion macros in
assertions.svhas part of #233, I missed that these are documented in the repository's README file. This PR updates the README to reflect those changes.